Package com.cisco.pt.ipc.system.impl
Class LockingTreeImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.LockingTreeImpl
- All Implemented Interfaces:
IPCObject,LockingTree
Information provided by the PKI file:
\class LockingTree
\brief LockingTree handles and manipulates the activity file locking tree.
\example appWindow().getActiveFile().getLockingTree()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionLockingTreeImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
LockingTreeImpl
public LockingTreeImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
setLock
Information provided by the PKI file:
\brief Locks or unlocks the specified locking item. \param ID, the name of the locking item. \param branchID1, the name from branch 1 (default is empty). \param branchID2, the name from branch 2 in branch 1 (default is empty). \param locked, true to lock the item, false to unlock the item.- Specified by:
setLockin interfaceLockingTree- Parameters:
ID- Takes in a parameter of IDbranchID1- Takes in a parameter of branchID1branchID2- Takes in a parameter of branchID2locked- Takes in a parameter of locked- Returns:
- boolean Returns a boolean
-
isLocked
Information provided by the PKI file:
\brief Returns true if the specified item is locked, otherwise false. \param ID, the name of the locking item. \param branchID1, the name from branch 1 (default is empty). \param branchID2, the name from branch 2 in branch 1 (default is empty).- Specified by:
isLockedin interfaceLockingTree- Parameters:
ID- Takes in a parameter of IDbranchID1- Takes in a parameter of branchID1branchID2- Takes in a parameter of branchID2- Returns:
- boolean Returns a boolean
-